home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / lists / gem / l_0799 / 790 < prev    next >
Encoding:
Internet Message Format  |  1994-08-27  |  3.4 KB
  1. Subject: Re: Online Help
  2. Date: Thu, 14 Jul 1994 11:24:30 -0400 (EDT)
  3. From: Chris Herborth <herborth@53iss6.waterloo.ncr.com>
  4. In-Reply-To: <2e23736411e733@elfhaven.ersys.edmonton.ab.ca> from "Michel Forget" at Jul 12, 94 04:51:58 pm
  5. Message-Id:  <9407141126.al09398@ncrhub1.NCR.COM>
  6. Precedence: bulk
  7.  
  8. What you wrote:
  9. > ST-Guide (there -is- an english version distributed by the author now) is
  10. > the tool that I suggested when I brought up the topic of online help.  It
  11. > is more flexible than 1ST-Guide, and uses a lot less memory.  I've been
  12. > using ST-Guide for a few months now, without any problems.  The format
  13. > for .STG files (the source files) is very simple, and you can do some
  14. > very interesting things, like control ST-Guie from within your own
  15. > application (for context sensitive online help).  Older versions had
  16. > a bug that caused a crash if you exited without closing the ST-Guide
  17. > window, but that seems to be cleared up now.
  18.  
  19. Is this available anywhere?  Will the author make it available for developers
  20. to distribute with their programs (ie, either donate it, or give us some
  21. sort of blurb saying "Here is X, and ST-Guide; see ST-GUIDE.TXT for more
  22. info about this excellent thing that we're using to provide online help.")?
  23.  
  24. The only other options I can think of for online documentation are:
  25.  
  26. 1) GNU's Info (using the TeXinfo format)
  27.    PROs - already a standard for GNU documentation
  28.         - already ported to the Atari
  29.         - produces excellent printed documentation as well as hypertext
  30.           online documentation _from_the_same_source_file_
  31.    CONs - no GEM version
  32.         - people will complain about having to write in the TeXinfo format
  33.           (which is a tagged format, more like TeX than anything else)
  34.  
  35. 2) HTML (HyperText Markup Language)
  36.    PROs - the standard for multimedia hypertext (including graphics,
  37.           sound, and video) on the World-Wide Web
  38.         - easy to create documents, even without an editor that understands
  39.           HTML (ie, it's a very simple markup language)
  40.         - can be used for printed documentation as well
  41.    CONs - no HTML browsers have been ported to plain TOS; the MiNT port
  42.           of Lynx requires MiNT-net and some hackery (ie, all it does on
  43.           my system is crash)
  44.         - people will complain about not having an editor that does the
  45.           HTML work for them (despite it being an easy format)
  46.  
  47. Other options would require a LOT of work, first in creating a standard
  48. help format, then in creating a standard markup language (or whatever)
  49. that could be used to create the help files, then in creating a help
  50. viewer of some sort.
  51.  
  52. If ST-Guide is a fairly easy format that supports some kind of formatting,
  53. hypertext links, and graphics, it sounds good enough to me.
  54.  
  55. The reason I'm asking all of this now is because I've volunteered some
  56. time to convert the POV-Ray help files (new! coming soon!) from whatever
  57. format they're in currently (they've got a custom DOS app for viewing
  58. them right now) to whatever format we decide is to be the standard for
  59. the Atari platform.  I guess if we go with HTML, I've got a lot of work
  60. to do, since I said I was going to try to make an HTML object for GEM++
  61. at some point...  ;-)
  62.  
  63. -- 
  64. ----------========================_   /\ ============================----------
  65. Chris Herborth                    \`o.0'       herborth@53iss6.Waterloo.NCR.COM
  66. Information Products Developer    =(___)=
  67. AT&T Global Information Solutions    U
  68.